LimsSpecimens Web Service
MethodLimsSpecimensChangeSpecimenType
Description
This method allows the user to change the specimen type attribute of a specified CoreOne Lims Specimen.
Request (LimsSpecimensChangeSpecimenType)

Below are the required parameters to successfully update the details of one specified CoreOne Lims Specimen. If any parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
xml:string
id

This is an internal CoreOne Lims Specimens id. It is used to specify which Lims Specimens record the user wishes to update.

These can be obtained through using the LimsAccessionsShow (Method).
xml:int
specimen_type_id

This is an internal CoreOne Specimen Type id. This is the new value of the specimen_type_id attribute for the specified Lims Specimen.

These can be obtained through using the SpecimensTypesIndex (Method).

xml:int
Response (LimsSpecimensChangeSpecimenType_response)

This is the returned status message to tell the user the result of the update.

An error message will be displayed instead of the status message if any of the input parameters fail any validation rule. For example if the user's token is invalid or the record doesn't exist. It will alert the user on what parameter failed validation and the reason why.

Response Body Parameters

NameDescriptionData Type
statusIf the lims specimen was successfully updated a message "Update successful." will be returned. If the lims specimen was not successfully updated a message "Update failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupLimsSpecimens Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.